Skip to content

feat: including relationships in migrations - #144

Open
endersoncosta wants to merge 9 commits into
herbsjs:mainfrom
endersoncosta:main
Open

feat: including relationships in migrations#144
endersoncosta wants to merge 9 commits into
herbsjs:mainfrom
endersoncosta:main

Conversation

@endersoncosta

Copy link
Copy Markdown
Contributor

With this we can write the relationship migrations based on our domain entities.

<%if (props.ref) {
props.ref.forEach(function(link){
if (link.relationship === 'One-to-One') { %>
// table.integer('<%-link.columnName %>').unsigned().nullable()

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this comment is necessary?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the idea are to not create a migration that does not work, due to not has an order of migrations when we write the files. These relationships throw errors due the dependence dont exist yet ...

@jhomarolo

Copy link
Copy Markdown
Contributor

@endersoncosta

Copy link
Copy Markdown
ContributorAuthor

Locally the tests are passing through. And other PRs apparently has the same problem from time to time.

Is possible to re-run the CI workflow?

@codecov

codecovBot commented Jul 7, 2022

Copy link
Copy Markdown

Codecov Report

Merging #144 (fb0b418) into main (56e99b7) will decrease coverage by 0.15%.
The diff coverage is 78.57%.

❗ Current head fb0b418 differs from pull request most recent head d8a12c6. Consider uploading reports for the commit d8a12c6 to get more accurate results

@@ Coverage Diff @@## main #144 +/- ##
==========================================
- Coverage 86.28% 86.13% -0.16% 
==========================================
Files 25 25 Lines 423 440 +17 ==========================================
+ Hits 365 379 +14 - Misses 58 61 +3 
Impacted FilesCoverage Δ
...rators/src/infra/database/migrations/migrations.js88.46% <73.91%> (-3.65%)⬇️
src/generators/utils.js83.33% <100.00%> (+1.85%)⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us.

@dalssoft

Copy link
Copy Markdown
Member

@endersoncosta about this generated code:

// table.integer('userId').unsigned().nullable()// table.foreign('userId').references('id').inTable('users')

(1) why .unsigned()?
(2) why .nullable()?
(3) why commented code? the dev would have other options for this operation?
(4) just table.integer('userId').references('id').inTable('users') works?

about this one:

knex.schema.table('markets',function(table){table.integer('companyId').unsigned().index().references('id').inTable('companys')})

(5) why .index()? FKs are normally already indexed.

template: `infra/data/database/${db.toLowerCase()}/migration.ejs`,
target: migrationFullPath,
props: { table: `${camelCase(name)}s`, columns: columns }
props: { table: `${camelCase(name)}s`, externalColumnName: `${camelCase(name)}Id`, columns, ref, idColumn }

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both table and columns name should be snake_cases for DB to keep with the current standard.

ex: userId -> user_id

}

if (isArrayWithType(type) && herbs.entity.isEntity(type[0]))
refs.push({ table: `${camelCase(type[0].name)}s`, relationship: 'One-to-Many' })

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both table and columns name should be snake_cases for DB to keep with the current standard.

ex: userId -> user_id

if (herbs.entity.isEntity(type)) {
const typeSchema = type.prototype.meta.schema
const idRef = Object.values(typeSchema).find(column => column.options.isId)?.name
refs.push({ id: idRef, columnName: `${camelCase(name)}Id`, table: `${camelCase(type.name)}s`, relationship: 'One-to-One' })

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both table and columns name should be snake_cases for DB to keep with the current standard.

ex: userId -> user_id

@endersoncosta

Copy link
Copy Markdown
ContributorAuthor

@endersoncosta about this generated code:

// table.integer('userId').unsigned().nullable()// table.foreign('userId').references('id').inTable('users')

(1) why .unsigned()?
(2) why .nullable()?
(3) why commented code? the dev would have other options for this operation?
(4) just table.integer('userId').references('id').inTable('users') works?

about this one:

knex.schema.table('markets',function(table){table.integer('companyId').unsigned().index().references('id').inTable('companys')})

(5) why .index()? FKs are normally already indexed.

1. unsigned() indeed this is used in MySQL to define the column to has just positive numbers, I think it is a good practice, but doesn't make any sense in postgres.

  1. To the initial setup this really doesn't has reason, but when we change the structure of an existing table, this can be necessary...

  2. We can't garantee the execution order, if the dev run all the migrations at the same time, this will break the execution with errors.

  3. Indeed, it is better in that simpler way.

  4. Indeed.

@dalssoft

dalssoft commented Jul 27, 2022

Copy link
Copy Markdown
Member

the CLI created the default entity user.js:

constUser=entity('User',{id: id(String),
...
})

when adding an entity with a reference:

constProject=entity('Project',{id: id(String),user: field(User),})

the generated migration:

.createTable('projects',function(table){table.string('id').primary()table.integer('user_id').references('id').inTable('users')

here the user_id should be .string() to follow the same type as the entity.

the same is true for 1:many:

.table('users',function(table){table.integer('customer_id').references('id').inTable('customers')})

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@endersoncosta@jhomarolo@dalssoft
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
feat: including relationships in migrations by endersoncosta · Pull Request #144 · herbsjs/herbs-cli · GitHub
Skip to content

feat: including relationships in migrations - #144

Open
endersoncosta wants to merge 9 commits into
herbsjs:mainfrom
endersoncosta:main
Open

feat: including relationships in migrations#144
endersoncosta wants to merge 9 commits into
herbsjs:mainfrom
endersoncosta:main

Conversation

@endersoncosta

Copy link
Copy Markdown
Contributor

With this we can write the relationship migrations based on our domain entities.

<%if (props.ref) {
props.ref.forEach(function(link){
if (link.relationship === 'One-to-One') { %>
// table.integer('<%-link.columnName %>').unsigned().nullable()

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this comment is necessary?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the idea are to not create a migration that does not work, due to not has an order of migrations when we write the files. These relationships throw errors due the dependence dont exist yet ...

@jhomarolo

Copy link
Copy Markdown
Contributor

@endersoncosta

Copy link
Copy Markdown
ContributorAuthor

Locally the tests are passing through. And other PRs apparently has the same problem from time to time.

Is possible to re-run the CI workflow?

@codecov

codecovBot commented Jul 7, 2022

Copy link
Copy Markdown

Codecov Report

Merging #144 (fb0b418) into main (56e99b7) will decrease coverage by 0.15%.
The diff coverage is 78.57%.

❗ Current head fb0b418 differs from pull request most recent head d8a12c6. Consider uploading reports for the commit d8a12c6 to get more accurate results

@@ Coverage Diff @@## main #144 +/- ##
==========================================
- Coverage 86.28% 86.13% -0.16% 
==========================================
Files 25 25 Lines 423 440 +17 ==========================================
+ Hits 365 379 +14 - Misses 58 61 +3 
Impacted FilesCoverage Δ
...rators/src/infra/database/migrations/migrations.js88.46% <73.91%> (-3.65%)⬇️
src/generators/utils.js83.33% <100.00%> (+1.85%)⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us.

@dalssoft

Copy link
Copy Markdown
Member

@endersoncosta about this generated code:

// table.integer('userId').unsigned().nullable()// table.foreign('userId').references('id').inTable('users')

(1) why .unsigned()?
(2) why .nullable()?
(3) why commented code? the dev would have other options for this operation?
(4) just table.integer('userId').references('id').inTable('users') works?

about this one:

knex.schema.table('markets',function(table){table.integer('companyId').unsigned().index().references('id').inTable('companys')})

(5) why .index()? FKs are normally already indexed.

template: `infra/data/database/${db.toLowerCase()}/migration.ejs`,
target: migrationFullPath,
props: { table: `${camelCase(name)}s`, columns: columns }
props: { table: `${camelCase(name)}s`, externalColumnName: `${camelCase(name)}Id`, columns, ref, idColumn }

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both table and columns name should be snake_cases for DB to keep with the current standard.

ex: userId -> user_id

}

if (isArrayWithType(type) && herbs.entity.isEntity(type[0]))
refs.push({ table: `${camelCase(type[0].name)}s`, relationship: 'One-to-Many' })

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both table and columns name should be snake_cases for DB to keep with the current standard.

ex: userId -> user_id

if (herbs.entity.isEntity(type)) {
const typeSchema = type.prototype.meta.schema
const idRef = Object.values(typeSchema).find(column => column.options.isId)?.name
refs.push({ id: idRef, columnName: `${camelCase(name)}Id`, table: `${camelCase(type.name)}s`, relationship: 'One-to-One' })

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both table and columns name should be snake_cases for DB to keep with the current standard.

ex: userId -> user_id

@endersoncosta

Copy link
Copy Markdown
ContributorAuthor

@endersoncosta about this generated code:

// table.integer('userId').unsigned().nullable()// table.foreign('userId').references('id').inTable('users')

(1) why .unsigned()?
(2) why .nullable()?
(3) why commented code? the dev would have other options for this operation?
(4) just table.integer('userId').references('id').inTable('users') works?

about this one:

knex.schema.table('markets',function(table){table.integer('companyId').unsigned().index().references('id').inTable('companys')})

(5) why .index()? FKs are normally already indexed.

1. unsigned() indeed this is used in MySQL to define the column to has just positive numbers, I think it is a good practice, but doesn't make any sense in postgres.

  1. To the initial setup this really doesn't has reason, but when we change the structure of an existing table, this can be necessary...

  2. We can't garantee the execution order, if the dev run all the migrations at the same time, this will break the execution with errors.

  3. Indeed, it is better in that simpler way.

  4. Indeed.

@dalssoft

dalssoft commented Jul 27, 2022

Copy link
Copy Markdown
Member

the CLI created the default entity user.js:

constUser=entity('User',{id: id(String),
...
})

when adding an entity with a reference:

constProject=entity('Project',{id: id(String),user: field(User),})

the generated migration:

.createTable('projects',function(table){table.string('id').primary()table.integer('user_id').references('id').inTable('users')

here the user_id should be .string() to follow the same type as the entity.

the same is true for 1:many:

.table('users',function(table){table.integer('customer_id').references('id').inTable('customers')})

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@endersoncosta@jhomarolo@dalssoft
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat: including relationships in migrations by endersoncosta · Pull Request #144 · herbsjs/herbs-cli · GitHub
Skip to content

feat: including relationships in migrations - #144

Open
endersoncosta wants to merge 9 commits into
herbsjs:mainfrom
endersoncosta:main
Open

feat: including relationships in migrations#144
endersoncosta wants to merge 9 commits into
herbsjs:mainfrom
endersoncosta:main

Conversation

@endersoncosta

Copy link
Copy Markdown
Contributor

With this we can write the relationship migrations based on our domain entities.

<%if (props.ref) {
props.ref.forEach(function(link){
if (link.relationship === 'One-to-One') { %>
// table.integer('<%-link.columnName %>').unsigned().nullable()

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this comment is necessary?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the idea are to not create a migration that does not work, due to not has an order of migrations when we write the files. These relationships throw errors due the dependence dont exist yet ...

@jhomarolo

Copy link
Copy Markdown
Contributor

@endersoncosta

Copy link
Copy Markdown
ContributorAuthor

Locally the tests are passing through. And other PRs apparently has the same problem from time to time.

Is possible to re-run the CI workflow?

@codecov

codecovBot commented Jul 7, 2022

Copy link
Copy Markdown

Codecov Report

Merging #144 (fb0b418) into main (56e99b7) will decrease coverage by 0.15%.
The diff coverage is 78.57%.

❗ Current head fb0b418 differs from pull request most recent head d8a12c6. Consider uploading reports for the commit d8a12c6 to get more accurate results

@@ Coverage Diff @@## main #144 +/- ##
==========================================
- Coverage 86.28% 86.13% -0.16% 
==========================================
Files 25 25 Lines 423 440 +17 ==========================================
+ Hits 365 379 +14 - Misses 58 61 +3 
Impacted FilesCoverage Δ
...rators/src/infra/database/migrations/migrations.js88.46% <73.91%> (-3.65%)⬇️
src/generators/utils.js83.33% <100.00%> (+1.85%)⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us.

@dalssoft

Copy link
Copy Markdown
Member

@endersoncosta about this generated code:

// table.integer('userId').unsigned().nullable()// table.foreign('userId').references('id').inTable('users')

(1) why .unsigned()?
(2) why .nullable()?
(3) why commented code? the dev would have other options for this operation?
(4) just table.integer('userId').references('id').inTable('users') works?

about this one:

knex.schema.table('markets',function(table){table.integer('companyId').unsigned().index().references('id').inTable('companys')})

(5) why .index()? FKs are normally already indexed.

template: `infra/data/database/${db.toLowerCase()}/migration.ejs`,
target: migrationFullPath,
props: { table: `${camelCase(name)}s`, columns: columns }
props: { table: `${camelCase(name)}s`, externalColumnName: `${camelCase(name)}Id`, columns, ref, idColumn }

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both table and columns name should be snake_cases for DB to keep with the current standard.

ex: userId -> user_id

}

if (isArrayWithType(type) && herbs.entity.isEntity(type[0]))
refs.push({ table: `${camelCase(type[0].name)}s`, relationship: 'One-to-Many' })

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both table and columns name should be snake_cases for DB to keep with the current standard.

ex: userId -> user_id

if (herbs.entity.isEntity(type)) {
const typeSchema = type.prototype.meta.schema
const idRef = Object.values(typeSchema).find(column => column.options.isId)?.name
refs.push({ id: idRef, columnName: `${camelCase(name)}Id`, table: `${camelCase(type.name)}s`, relationship: 'One-to-One' })

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both table and columns name should be snake_cases for DB to keep with the current standard.

ex: userId -> user_id

@endersoncosta

Copy link
Copy Markdown
ContributorAuthor

@endersoncosta about this generated code:

// table.integer('userId').unsigned().nullable()// table.foreign('userId').references('id').inTable('users')

(1) why .unsigned()?
(2) why .nullable()?
(3) why commented code? the dev would have other options for this operation?
(4) just table.integer('userId').references('id').inTable('users') works?

about this one:

knex.schema.table('markets',function(table){table.integer('companyId').unsigned().index().references('id').inTable('companys')})

(5) why .index()? FKs are normally already indexed.

1. unsigned() indeed this is used in MySQL to define the column to has just positive numbers, I think it is a good practice, but doesn't make any sense in postgres.

  1. To the initial setup this really doesn't has reason, but when we change the structure of an existing table, this can be necessary...

  2. We can't garantee the execution order, if the dev run all the migrations at the same time, this will break the execution with errors.

  3. Indeed, it is better in that simpler way.

  4. Indeed.

@dalssoft

dalssoft commented Jul 27, 2022

Copy link
Copy Markdown
Member

the CLI created the default entity user.js:

constUser=entity('User',{id: id(String),
...
})

when adding an entity with a reference:

constProject=entity('Project',{id: id(String),user: field(User),})

the generated migration:

.createTable('projects',function(table){table.string('id').primary()table.integer('user_id').references('id').inTable('users')

here the user_id should be .string() to follow the same type as the entity.

the same is true for 1:many:

.table('users',function(table){table.integer('customer_id').references('id').inTable('customers')})

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@endersoncosta@jhomarolo@dalssoft
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat: including relationships in migrations by endersoncosta · Pull Request #144 · herbsjs/herbs-cli · GitHub
Skip to content

feat: including relationships in migrations - #144

Open
endersoncosta wants to merge 9 commits into
herbsjs:mainfrom
endersoncosta:main
Open

feat: including relationships in migrations#144
endersoncosta wants to merge 9 commits into
herbsjs:mainfrom
endersoncosta:main

Conversation

@endersoncosta

Copy link
Copy Markdown
Contributor

With this we can write the relationship migrations based on our domain entities.

<%if (props.ref) {
props.ref.forEach(function(link){
if (link.relationship === 'One-to-One') { %>
// table.integer('<%-link.columnName %>').unsigned().nullable()

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this comment is necessary?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the idea are to not create a migration that does not work, due to not has an order of migrations when we write the files. These relationships throw errors due the dependence dont exist yet ...

@jhomarolo

Copy link
Copy Markdown
Contributor

@endersoncosta

Copy link
Copy Markdown
ContributorAuthor

Locally the tests are passing through. And other PRs apparently has the same problem from time to time.

Is possible to re-run the CI workflow?

@codecov

codecovBot commented Jul 7, 2022

Copy link
Copy Markdown

Codecov Report

Merging #144 (fb0b418) into main (56e99b7) will decrease coverage by 0.15%.
The diff coverage is 78.57%.

❗ Current head fb0b418 differs from pull request most recent head d8a12c6. Consider uploading reports for the commit d8a12c6 to get more accurate results

@@ Coverage Diff @@## main #144 +/- ##
==========================================
- Coverage 86.28% 86.13% -0.16% 
==========================================
Files 25 25 Lines 423 440 +17 ==========================================
+ Hits 365 379 +14 - Misses 58 61 +3 
Impacted FilesCoverage Δ
...rators/src/infra/database/migrations/migrations.js88.46% <73.91%> (-3.65%)⬇️
src/generators/utils.js83.33% <100.00%> (+1.85%)⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us.

@dalssoft

Copy link
Copy Markdown
Member

@endersoncosta about this generated code:

// table.integer('userId').unsigned().nullable()// table.foreign('userId').references('id').inTable('users')

(1) why .unsigned()?
(2) why .nullable()?
(3) why commented code? the dev would have other options for this operation?
(4) just table.integer('userId').references('id').inTable('users') works?

about this one:

knex.schema.table('markets',function(table){table.integer('companyId').unsigned().index().references('id').inTable('companys')})

(5) why .index()? FKs are normally already indexed.

template: `infra/data/database/${db.toLowerCase()}/migration.ejs`,
target: migrationFullPath,
props: { table: `${camelCase(name)}s`, columns: columns }
props: { table: `${camelCase(name)}s`, externalColumnName: `${camelCase(name)}Id`, columns, ref, idColumn }

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both table and columns name should be snake_cases for DB to keep with the current standard.

ex: userId -> user_id

}

if (isArrayWithType(type) && herbs.entity.isEntity(type[0]))
refs.push({ table: `${camelCase(type[0].name)}s`, relationship: 'One-to-Many' })

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both table and columns name should be snake_cases for DB to keep with the current standard.

ex: userId -> user_id

if (herbs.entity.isEntity(type)) {
const typeSchema = type.prototype.meta.schema
const idRef = Object.values(typeSchema).find(column => column.options.isId)?.name
refs.push({ id: idRef, columnName: `${camelCase(name)}Id`, table: `${camelCase(type.name)}s`, relationship: 'One-to-One' })

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both table and columns name should be snake_cases for DB to keep with the current standard.

ex: userId -> user_id

@endersoncosta

Copy link
Copy Markdown
ContributorAuthor

@endersoncosta about this generated code:

// table.integer('userId').unsigned().nullable()// table.foreign('userId').references('id').inTable('users')

(1) why .unsigned()?
(2) why .nullable()?
(3) why commented code? the dev would have other options for this operation?
(4) just table.integer('userId').references('id').inTable('users') works?

about this one:

knex.schema.table('markets',function(table){table.integer('companyId').unsigned().index().references('id').inTable('companys')})

(5) why .index()? FKs are normally already indexed.

1. unsigned() indeed this is used in MySQL to define the column to has just positive numbers, I think it is a good practice, but doesn't make any sense in postgres.

  1. To the initial setup this really doesn't has reason, but when we change the structure of an existing table, this can be necessary...

  2. We can't garantee the execution order, if the dev run all the migrations at the same time, this will break the execution with errors.

  3. Indeed, it is better in that simpler way.

  4. Indeed.

@dalssoft

dalssoft commented Jul 27, 2022

Copy link
Copy Markdown
Member

the CLI created the default entity user.js:

constUser=entity('User',{id: id(String),
...
})

when adding an entity with a reference:

constProject=entity('Project',{id: id(String),user: field(User),})

the generated migration:

.createTable('projects',function(table){table.string('id').primary()table.integer('user_id').references('id').inTable('users')

here the user_id should be .string() to follow the same type as the entity.

the same is true for 1:many:

.table('users',function(table){table.integer('customer_id').references('id').inTable('customers')})

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@endersoncosta@jhomarolo@dalssoft
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' feat: including relationships in migrations by endersoncosta · Pull Request #144 · herbsjs/herbs-cli · GitHub
Skip to content

feat: including relationships in migrations - #144

Open
endersoncosta wants to merge 9 commits into
herbsjs:mainfrom
endersoncosta:main
Open

feat: including relationships in migrations#144
endersoncosta wants to merge 9 commits into
herbsjs:mainfrom
endersoncosta:main

Conversation

@endersoncosta

Copy link
Copy Markdown
Contributor

With this we can write the relationship migrations based on our domain entities.

<%if (props.ref) {
props.ref.forEach(function(link){
if (link.relationship === 'One-to-One') { %>
// table.integer('<%-link.columnName %>').unsigned().nullable()

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this comment is necessary?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the idea are to not create a migration that does not work, due to not has an order of migrations when we write the files. These relationships throw errors due the dependence dont exist yet ...

@jhomarolo

Copy link
Copy Markdown
Contributor

@endersoncosta

Copy link
Copy Markdown
ContributorAuthor

Locally the tests are passing through. And other PRs apparently has the same problem from time to time.

Is possible to re-run the CI workflow?

@codecov

codecovBot commented Jul 7, 2022

Copy link
Copy Markdown

Codecov Report

Merging #144 (fb0b418) into main (56e99b7) will decrease coverage by 0.15%.
The diff coverage is 78.57%.

❗ Current head fb0b418 differs from pull request most recent head d8a12c6. Consider uploading reports for the commit d8a12c6 to get more accurate results

@@ Coverage Diff @@## main #144 +/- ##
==========================================
- Coverage 86.28% 86.13% -0.16% 
==========================================
Files 25 25 Lines 423 440 +17 ==========================================
+ Hits 365 379 +14 - Misses 58 61 +3 
Impacted FilesCoverage Δ
...rators/src/infra/database/migrations/migrations.js88.46% <73.91%> (-3.65%)⬇️
src/generators/utils.js83.33% <100.00%> (+1.85%)⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us.

@dalssoft

Copy link
Copy Markdown
Member

@endersoncosta about this generated code:

// table.integer('userId').unsigned().nullable()// table.foreign('userId').references('id').inTable('users')

(1) why .unsigned()?
(2) why .nullable()?
(3) why commented code? the dev would have other options for this operation?
(4) just table.integer('userId').references('id').inTable('users') works?

about this one:

knex.schema.table('markets',function(table){table.integer('companyId').unsigned().index().references('id').inTable('companys')})

(5) why .index()? FKs are normally already indexed.

template: `infra/data/database/${db.toLowerCase()}/migration.ejs`,
target: migrationFullPath,
props: { table: `${camelCase(name)}s`, columns: columns }
props: { table: `${camelCase(name)}s`, externalColumnName: `${camelCase(name)}Id`, columns, ref, idColumn }

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both table and columns name should be snake_cases for DB to keep with the current standard.

ex: userId -> user_id

}

if (isArrayWithType(type) && herbs.entity.isEntity(type[0]))
refs.push({ table: `${camelCase(type[0].name)}s`, relationship: 'One-to-Many' })

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both table and columns name should be snake_cases for DB to keep with the current standard.

ex: userId -> user_id

if (herbs.entity.isEntity(type)) {
const typeSchema = type.prototype.meta.schema
const idRef = Object.values(typeSchema).find(column => column.options.isId)?.name
refs.push({ id: idRef, columnName: `${camelCase(name)}Id`, table: `${camelCase(type.name)}s`, relationship: 'One-to-One' })

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both table and columns name should be snake_cases for DB to keep with the current standard.

ex: userId -> user_id

@endersoncosta

Copy link
Copy Markdown
ContributorAuthor

@endersoncosta about this generated code:

// table.integer('userId').unsigned().nullable()// table.foreign('userId').references('id').inTable('users')

(1) why .unsigned()?
(2) why .nullable()?
(3) why commented code? the dev would have other options for this operation?
(4) just table.integer('userId').references('id').inTable('users') works?

about this one:

knex.schema.table('markets',function(table){table.integer('companyId').unsigned().index().references('id').inTable('companys')})

(5) why .index()? FKs are normally already indexed.

1. unsigned() indeed this is used in MySQL to define the column to has just positive numbers, I think it is a good practice, but doesn't make any sense in postgres.

  1. To the initial setup this really doesn't has reason, but when we change the structure of an existing table, this can be necessary...

  2. We can't garantee the execution order, if the dev run all the migrations at the same time, this will break the execution with errors.

  3. Indeed, it is better in that simpler way.

  4. Indeed.

@dalssoft

dalssoft commented Jul 27, 2022

Copy link
Copy Markdown
Member

the CLI created the default entity user.js:

constUser=entity('User',{id: id(String),
...
})

when adding an entity with a reference:

constProject=entity('Project',{id: id(String),user: field(User),})

the generated migration:

.createTable('projects',function(table){table.string('id').primary()table.integer('user_id').references('id').inTable('users')

here the user_id should be .string() to follow the same type as the entity.

the same is true for 1:many:

.table('users',function(table){table.integer('customer_id').references('id').inTable('customers')})

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@endersoncosta@jhomarolo@dalssoft
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat: including relationships in migrations by endersoncosta · Pull Request #144 · herbsjs/herbs-cli · GitHub
Skip to content

feat: including relationships in migrations - #144

Open
endersoncosta wants to merge 9 commits into
herbsjs:mainfrom
endersoncosta:main
Open

feat: including relationships in migrations#144
endersoncosta wants to merge 9 commits into
herbsjs:mainfrom
endersoncosta:main

Conversation

@endersoncosta

Copy link
Copy Markdown
Contributor

With this we can write the relationship migrations based on our domain entities.

<%if (props.ref) {
props.ref.forEach(function(link){
if (link.relationship === 'One-to-One') { %>
// table.integer('<%-link.columnName %>').unsigned().nullable()

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this comment is necessary?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the idea are to not create a migration that does not work, due to not has an order of migrations when we write the files. These relationships throw errors due the dependence dont exist yet ...

@jhomarolo

Copy link
Copy Markdown
Contributor

@endersoncosta

Copy link
Copy Markdown
ContributorAuthor

Locally the tests are passing through. And other PRs apparently has the same problem from time to time.

Is possible to re-run the CI workflow?

@codecov

codecovBot commented Jul 7, 2022

Copy link
Copy Markdown

Codecov Report

Merging #144 (fb0b418) into main (56e99b7) will decrease coverage by 0.15%.
The diff coverage is 78.57%.

❗ Current head fb0b418 differs from pull request most recent head d8a12c6. Consider uploading reports for the commit d8a12c6 to get more accurate results

@@ Coverage Diff @@## main #144 +/- ##
==========================================
- Coverage 86.28% 86.13% -0.16% 
==========================================
Files 25 25 Lines 423 440 +17 ==========================================
+ Hits 365 379 +14 - Misses 58 61 +3 
Impacted FilesCoverage Δ
...rators/src/infra/database/migrations/migrations.js88.46% <73.91%> (-3.65%)⬇️
src/generators/utils.js83.33% <100.00%> (+1.85%)⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us.

@dalssoft

Copy link
Copy Markdown
Member

@endersoncosta about this generated code:

// table.integer('userId').unsigned().nullable()// table.foreign('userId').references('id').inTable('users')

(1) why .unsigned()?
(2) why .nullable()?
(3) why commented code? the dev would have other options for this operation?
(4) just table.integer('userId').references('id').inTable('users') works?

about this one:

knex.schema.table('markets',function(table){table.integer('companyId').unsigned().index().references('id').inTable('companys')})

(5) why .index()? FKs are normally already indexed.

template: `infra/data/database/${db.toLowerCase()}/migration.ejs`,
target: migrationFullPath,
props: { table: `${camelCase(name)}s`, columns: columns }
props: { table: `${camelCase(name)}s`, externalColumnName: `${camelCase(name)}Id`, columns, ref, idColumn }

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both table and columns name should be snake_cases for DB to keep with the current standard.

ex: userId -> user_id

}

if (isArrayWithType(type) && herbs.entity.isEntity(type[0]))
refs.push({ table: `${camelCase(type[0].name)}s`, relationship: 'One-to-Many' })

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both table and columns name should be snake_cases for DB to keep with the current standard.

ex: userId -> user_id

if (herbs.entity.isEntity(type)) {
const typeSchema = type.prototype.meta.schema
const idRef = Object.values(typeSchema).find(column => column.options.isId)?.name
refs.push({ id: idRef, columnName: `${camelCase(name)}Id`, table: `${camelCase(type.name)}s`, relationship: 'One-to-One' })

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both table and columns name should be snake_cases for DB to keep with the current standard.

ex: userId -> user_id

@endersoncosta

Copy link
Copy Markdown
ContributorAuthor

@endersoncosta about this generated code:

// table.integer('userId').unsigned().nullable()// table.foreign('userId').references('id').inTable('users')

(1) why .unsigned()?
(2) why .nullable()?
(3) why commented code? the dev would have other options for this operation?
(4) just table.integer('userId').references('id').inTable('users') works?

about this one:

knex.schema.table('markets',function(table){table.integer('companyId').unsigned().index().references('id').inTable('companys')})

(5) why .index()? FKs are normally already indexed.

1. unsigned() indeed this is used in MySQL to define the column to has just positive numbers, I think it is a good practice, but doesn't make any sense in postgres.

  1. To the initial setup this really doesn't has reason, but when we change the structure of an existing table, this can be necessary...

  2. We can't garantee the execution order, if the dev run all the migrations at the same time, this will break the execution with errors.

  3. Indeed, it is better in that simpler way.

  4. Indeed.

@dalssoft

dalssoft commented Jul 27, 2022

Copy link
Copy Markdown
Member

the CLI created the default entity user.js:

constUser=entity('User',{id: id(String),
...
})

when adding an entity with a reference:

constProject=entity('Project',{id: id(String),user: field(User),})

the generated migration:

.createTable('projects',function(table){table.string('id').primary()table.integer('user_id').references('id').inTable('users')

here the user_id should be .string() to follow the same type as the entity.

the same is true for 1:many:

.table('users',function(table){table.integer('customer_id').references('id').inTable('customers')})

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@endersoncosta@jhomarolo@dalssoft
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat: including relationships in migrations by endersoncosta · Pull Request #144 · herbsjs/herbs-cli · GitHub
Skip to content

feat: including relationships in migrations - #144

Open
endersoncosta wants to merge 9 commits into
herbsjs:mainfrom
endersoncosta:main
Open

feat: including relationships in migrations#144
endersoncosta wants to merge 9 commits into
herbsjs:mainfrom
endersoncosta:main

Conversation

@endersoncosta

Copy link
Copy Markdown
Contributor

With this we can write the relationship migrations based on our domain entities.

<%if (props.ref) {
props.ref.forEach(function(link){
if (link.relationship === 'One-to-One') { %>
// table.integer('<%-link.columnName %>').unsigned().nullable()

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this comment is necessary?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the idea are to not create a migration that does not work, due to not has an order of migrations when we write the files. These relationships throw errors due the dependence dont exist yet ...

@jhomarolo

Copy link
Copy Markdown
Contributor

@endersoncosta

Copy link
Copy Markdown
ContributorAuthor

Locally the tests are passing through. And other PRs apparently has the same problem from time to time.

Is possible to re-run the CI workflow?

@codecov

codecovBot commented Jul 7, 2022

Copy link
Copy Markdown

Codecov Report

Merging #144 (fb0b418) into main (56e99b7) will decrease coverage by 0.15%.
The diff coverage is 78.57%.

❗ Current head fb0b418 differs from pull request most recent head d8a12c6. Consider uploading reports for the commit d8a12c6 to get more accurate results

@@ Coverage Diff @@## main #144 +/- ##
==========================================
- Coverage 86.28% 86.13% -0.16% 
==========================================
Files 25 25 Lines 423 440 +17 ==========================================
+ Hits 365 379 +14 - Misses 58 61 +3 
Impacted FilesCoverage Δ
...rators/src/infra/database/migrations/migrations.js88.46% <73.91%> (-3.65%)⬇️
src/generators/utils.js83.33% <100.00%> (+1.85%)⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us.

@dalssoft

Copy link
Copy Markdown
Member

@endersoncosta about this generated code:

// table.integer('userId').unsigned().nullable()// table.foreign('userId').references('id').inTable('users')

(1) why .unsigned()?
(2) why .nullable()?
(3) why commented code? the dev would have other options for this operation?
(4) just table.integer('userId').references('id').inTable('users') works?

about this one:

knex.schema.table('markets',function(table){table.integer('companyId').unsigned().index().references('id').inTable('companys')})

(5) why .index()? FKs are normally already indexed.

template: `infra/data/database/${db.toLowerCase()}/migration.ejs`,
target: migrationFullPath,
props: { table: `${camelCase(name)}s`, columns: columns }
props: { table: `${camelCase(name)}s`, externalColumnName: `${camelCase(name)}Id`, columns, ref, idColumn }

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both table and columns name should be snake_cases for DB to keep with the current standard.

ex: userId -> user_id

}

if (isArrayWithType(type) && herbs.entity.isEntity(type[0]))
refs.push({ table: `${camelCase(type[0].name)}s`, relationship: 'One-to-Many' })

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both table and columns name should be snake_cases for DB to keep with the current standard.

ex: userId -> user_id

if (herbs.entity.isEntity(type)) {
const typeSchema = type.prototype.meta.schema
const idRef = Object.values(typeSchema).find(column => column.options.isId)?.name
refs.push({ id: idRef, columnName: `${camelCase(name)}Id`, table: `${camelCase(type.name)}s`, relationship: 'One-to-One' })

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both table and columns name should be snake_cases for DB to keep with the current standard.

ex: userId -> user_id

@endersoncosta

Copy link
Copy Markdown
ContributorAuthor

@endersoncosta about this generated code:

// table.integer('userId').unsigned().nullable()// table.foreign('userId').references('id').inTable('users')

(1) why .unsigned()?
(2) why .nullable()?
(3) why commented code? the dev would have other options for this operation?
(4) just table.integer('userId').references('id').inTable('users') works?

about this one:

knex.schema.table('markets',function(table){table.integer('companyId').unsigned().index().references('id').inTable('companys')})

(5) why .index()? FKs are normally already indexed.

1. unsigned() indeed this is used in MySQL to define the column to has just positive numbers, I think it is a good practice, but doesn't make any sense in postgres.

  1. To the initial setup this really doesn't has reason, but when we change the structure of an existing table, this can be necessary...

  2. We can't garantee the execution order, if the dev run all the migrations at the same time, this will break the execution with errors.

  3. Indeed, it is better in that simpler way.

  4. Indeed.

@dalssoft

dalssoft commented Jul 27, 2022

Copy link
Copy Markdown
Member

the CLI created the default entity user.js:

constUser=entity('User',{id: id(String),
...
})

when adding an entity with a reference:

constProject=entity('Project',{id: id(String),user: field(User),})

the generated migration:

.createTable('projects',function(table){table.string('id').primary()table.integer('user_id').references('id').inTable('users')

here the user_id should be .string() to follow the same type as the entity.

the same is true for 1:many:

.table('users',function(table){table.integer('customer_id').references('id').inTable('customers')})

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@endersoncosta@jhomarolo@dalssoft
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); feat: including relationships in migrations by endersoncosta · Pull Request #144 · herbsjs/herbs-cli · GitHub
Skip to content

feat: including relationships in migrations - #144

Open
endersoncosta wants to merge 9 commits into
herbsjs:mainfrom
endersoncosta:main
Open

feat: including relationships in migrations#144
endersoncosta wants to merge 9 commits into
herbsjs:mainfrom
endersoncosta:main

Conversation

@endersoncosta

Copy link
Copy Markdown
Contributor

With this we can write the relationship migrations based on our domain entities.

<%if (props.ref) {
props.ref.forEach(function(link){
if (link.relationship === 'One-to-One') { %>
// table.integer('<%-link.columnName %>').unsigned().nullable()

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this comment is necessary?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the idea are to not create a migration that does not work, due to not has an order of migrations when we write the files. These relationships throw errors due the dependence dont exist yet ...

@jhomarolo

Copy link
Copy Markdown
Contributor

@endersoncosta

Copy link
Copy Markdown
ContributorAuthor

Locally the tests are passing through. And other PRs apparently has the same problem from time to time.

Is possible to re-run the CI workflow?

@codecov

codecovBot commented Jul 7, 2022

Copy link
Copy Markdown

Codecov Report

Merging #144 (fb0b418) into main (56e99b7) will decrease coverage by 0.15%.
The diff coverage is 78.57%.

❗ Current head fb0b418 differs from pull request most recent head d8a12c6. Consider uploading reports for the commit d8a12c6 to get more accurate results

@@ Coverage Diff @@## main #144 +/- ##
==========================================
- Coverage 86.28% 86.13% -0.16% 
==========================================
Files 25 25 Lines 423 440 +17 ==========================================
+ Hits 365 379 +14 - Misses 58 61 +3 
Impacted FilesCoverage Δ
...rators/src/infra/database/migrations/migrations.js88.46% <73.91%> (-3.65%)⬇️
src/generators/utils.js83.33% <100.00%> (+1.85%)⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us.

@dalssoft

Copy link
Copy Markdown
Member

@endersoncosta about this generated code:

// table.integer('userId').unsigned().nullable()// table.foreign('userId').references('id').inTable('users')

(1) why .unsigned()?
(2) why .nullable()?
(3) why commented code? the dev would have other options for this operation?
(4) just table.integer('userId').references('id').inTable('users') works?

about this one:

knex.schema.table('markets',function(table){table.integer('companyId').unsigned().index().references('id').inTable('companys')})

(5) why .index()? FKs are normally already indexed.

template: `infra/data/database/${db.toLowerCase()}/migration.ejs`,
target: migrationFullPath,
props: { table: `${camelCase(name)}s`, columns: columns }
props: { table: `${camelCase(name)}s`, externalColumnName: `${camelCase(name)}Id`, columns, ref, idColumn }

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both table and columns name should be snake_cases for DB to keep with the current standard.

ex: userId -> user_id

}

if (isArrayWithType(type) && herbs.entity.isEntity(type[0]))
refs.push({ table: `${camelCase(type[0].name)}s`, relationship: 'One-to-Many' })

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both table and columns name should be snake_cases for DB to keep with the current standard.

ex: userId -> user_id

if (herbs.entity.isEntity(type)) {
const typeSchema = type.prototype.meta.schema
const idRef = Object.values(typeSchema).find(column => column.options.isId)?.name
refs.push({ id: idRef, columnName: `${camelCase(name)}Id`, table: `${camelCase(type.name)}s`, relationship: 'One-to-One' })

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both table and columns name should be snake_cases for DB to keep with the current standard.

ex: userId -> user_id

@endersoncosta

Copy link
Copy Markdown
ContributorAuthor

@endersoncosta about this generated code:

// table.integer('userId').unsigned().nullable()// table.foreign('userId').references('id').inTable('users')

(1) why .unsigned()?
(2) why .nullable()?
(3) why commented code? the dev would have other options for this operation?
(4) just table.integer('userId').references('id').inTable('users') works?

about this one:

knex.schema.table('markets',function(table){table.integer('companyId').unsigned().index().references('id').inTable('companys')})

(5) why .index()? FKs are normally already indexed.

1. unsigned() indeed this is used in MySQL to define the column to has just positive numbers, I think it is a good practice, but doesn't make any sense in postgres.

  1. To the initial setup this really doesn't has reason, but when we change the structure of an existing table, this can be necessary...

  2. We can't garantee the execution order, if the dev run all the migrations at the same time, this will break the execution with errors.

  3. Indeed, it is better in that simpler way.

  4. Indeed.

@dalssoft

dalssoft commented Jul 27, 2022

Copy link
Copy Markdown
Member

the CLI created the default entity user.js:

constUser=entity('User',{id: id(String),
...
})

when adding an entity with a reference:

constProject=entity('Project',{id: id(String),user: field(User),})

the generated migration:

.createTable('projects',function(table){table.string('id').primary()table.integer('user_id').references('id').inTable('users')

here the user_id should be .string() to follow the same type as the entity.

the same is true for 1:many:

.table('users',function(table){table.integer('customer_id').references('id').inTable('customers')})

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@endersoncosta@jhomarolo@dalssoft