[docs] Allow codesandbox deploy for demos in X #23644

oliviertassinari · 2020-11-21T17:50:14Z

The objective of this pull request is to get the same great DX of #22616 but for Material-UI X. Over the last few weeks, I have found myself going to the codesandbox-ci UI to get the published package many times. The workflow is especially useful when reviewing.

Once the changes are merged, I will cherry-pick it to master and complete the integration on mui/mui-x#613.

mui-pr-bot · 2020-11-21T17:52:56Z

No bundle size changes

Generated by 🚫 dangerJS against 249e61f

eps1lon

Please inline it in the repo.

oliviertassinari · 2020-11-22T11:21:48Z

Please inline it in the repo.

@eps1lon I can't inline it, we don't have customization points, as far as I know :/. I think that it would be ideal if each repository to have their custom logic. This approach seemed to be the least worse available.

eps1lon · 2020-11-22T11:23:41Z

I can't inline it, we don't have customization points, as far as I know :/. I think that it would be ideal if each repository to have their custom logic. This approach seemed to be the least worse available.

Then create it. But don't abstract the wrong thing. You're creating more maintenance burden for both repos instead of just one.

oliviertassinari · 2020-11-22T11:43:09Z

@eps1lon Would it work with you if we use the context to inject customizations around how the export to code sandbox behaves?

oliviertassinari · 2020-11-28T11:45:48Z

docs/src/modules/utils/helpers.test.js

@@ -62,19 +62,6 @@ const suggestions = [
    });
  });

-  it('should support next dependencies', () => {
-    expect(getDependencies(s1, { reactVersion: 'next' })).to.deep.equal({


Doesn't seem relevant, support removed.

oliviertassinari · 2020-11-28T11:46:16Z

docs/src/modules/utils/helpers.js

@@ -183,7 +180,7 @@ function getDependencies(raw, options = {}) {
    }
  }

-  includePeerDependencies(deps, versions);
+  deps = includePeerDependencies(deps, versions);


Prefer immutability

oliviertassinari · 2020-11-28T11:47:33Z

docs/src/modules/utils/helpers.js

-  if (
-    deps['@material-ui/lab'] ||
-    deps['@material-ui/x'] ||
-    deps['@material-ui/x-grid'] ||
-    deps['@material-ui/x-pickers'] ||
-    deps['@material-ui/x-tree-view'] ||
-    deps['@material-ui/data-grid']
-  ) {
-    deps['@material-ui/core'] = versions['@material-ui/core'];
+  if (newDeps['@material-ui/lab']) {
+    newDeps['@material-ui/core'] = versions['@material-ui/core'];
  }

-  if (deps['@material-ui/x-grid-data-generator']) {
-    deps['@material-ui/core'] = versions['@material-ui/core'];
-    deps['@material-ui/icons'] = versions['@material-ui/icons'];
-    deps['@material-ui/lab'] = versions['@material-ui/lab'];


Remove the logic, prefer hosting it in https://github.com/mui-org/material-ui-x.

feedback taken into account, add customization points so we can have a faster feedback loop

oliviertassinari · 2020-11-28T11:49:54Z

docs/src/modules/utils/getDemoConfig.js

@@ -79,7 +79,7 @@ function getLanguageConfig(demoData) {
  }
 }

-export default function getDemo(demoData) {
+export default function getDemoConfig(demoData) {


Per convention

eps1lon · 2020-11-29T13:17:57Z

I don't think this is a good idea. Can we please revisit that once we recognize churn across the repositories? Until then we should just copy the code.

oliviertassinari · 2020-11-29T13:57:56Z

once we recognize churn across the repositories

What do you mean?

Until then we should just copy the code.

This would require to duplicate dozens of unrelated files (drill down in the dependency file chain). It would force duplicating the effort each time we release an improvement. We need to share more code, not less.

eps1lon · 2020-11-30T10:28:04Z

What do you mean?

Once we recognize that we change multiple locations at the same time we can look into how we abstract it. Here: If we change the duplication in both repositories often we can abstract the lines we often change.

This would require to duplicate dozens of unrelated files (drill down in the dependency file chain). It would force duplicating the effort each time we release an improvement.

Sounds great. Let's do it.

We need to share more code, not less.

That's not generally true.

oliviertassinari · 2020-11-30T12:18:21Z

Ok, so you want to identify the places where we need to customize the documentation for the use cases of another package. From what I understand it's what we have done so far, this pull request is another example.

The duplication path is not an option because it reduces the constraints, it's critical that Material-UI X uses the infrastructure of the main repository. We don't have the bandwidth to duplicate the effort. So I think that we need to provide a customization API. The approach with the global seems simple enough. It allows moving code away from here (for packages that aren't hosted in this repository)

eps1lon · 2020-12-03T21:36:12Z

You're harming willingly the repository for reasons you're not sharing with your fellow collaborators.

oliviertassinari · 2020-12-04T12:21:10Z

I don't understand how it's harming the codebase. I believe it's the opposite, it enforces more constraints, helps with code sharing and consistency.

There is one aspect that I can envision as remotely harmful, is at the scope of mui-org/material-ui in isolation if ignoring the overall benefit for mui-org that is positive. Changes to the "public API" here will have to take into account how the code is used in https://github.com/mui-org/material-ui-x. The creation of different repositories is part of this tradeoff. The motivation was to avoid potential confusion among developers around what's MIT and what's GPL-v3 or commercial. It comes with downsides, this one was anticipated. I think that we can still reevaluate if this was the right call in a couple of months, see if we should merge or not.

oliviertassinari · 2020-12-04T12:23:56Z

These changes remove the custom code I have added for packages like @material-ui/x-grid that are documented on mui-org/material-ui-x. I think that it's a win :)

oliviertassinari added the docs Improvements or additions to the documentation label Nov 21, 2020

eps1lon previously requested changes Nov 22, 2020

View reviewed changes

[docs] Allow codesandbox deploy for demos in X

402aa13

oliviertassinari force-pushed the docs-support-codesandbox-x branch from e7f1f50 to 805335d Compare November 28, 2020 11:45

oliviertassinari commented Nov 28, 2020

View reviewed changes

Sebastian's review

249e61f

oliviertassinari force-pushed the docs-support-codesandbox-x branch from 805335d to 249e61f Compare November 28, 2020 11:59

oliviertassinari mentioned this pull request Nov 28, 2020

[docs] Enable codesandbox preview in PRs mui/mui-x#613

Merged

oliviertassinari requested a review from eps1lon November 28, 2020 12:20

oliviertassinari merged commit c44558e into mui:next Dec 3, 2020

oliviertassinari deleted the docs-support-codesandbox-x branch December 3, 2020 21:21

oliviertassinari added a commit that referenced this pull request Dec 4, 2020

[docs] Allow codesandbox deploy for demos in X (#23644)

34be88e

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[docs] Allow codesandbox deploy for demos in X #23644

[docs] Allow codesandbox deploy for demos in X #23644

oliviertassinari commented Nov 21, 2020 •

edited

mui-pr-bot commented Nov 21, 2020 •

edited

eps1lon left a comment

oliviertassinari commented Nov 22, 2020 •

edited

eps1lon commented Nov 22, 2020 •

edited

oliviertassinari commented Nov 22, 2020 •

edited

oliviertassinari Nov 28, 2020

oliviertassinari Nov 28, 2020

oliviertassinari Nov 28, 2020 •

edited

oliviertassinari Nov 28, 2020

eps1lon commented Nov 29, 2020

oliviertassinari commented Nov 29, 2020 •

edited

eps1lon commented Nov 30, 2020

oliviertassinari commented Nov 30, 2020 •

edited

eps1lon commented Dec 3, 2020

oliviertassinari commented Dec 4, 2020 •

edited

oliviertassinari commented Dec 4, 2020 •

edited

[docs] Allow codesandbox deploy for demos in X #23644

[docs] Allow codesandbox deploy for demos in X #23644

Conversation

oliviertassinari commented Nov 21, 2020 • edited

mui-pr-bot commented Nov 21, 2020 • edited

eps1lon left a comment

Choose a reason for hiding this comment

oliviertassinari commented Nov 22, 2020 • edited

eps1lon commented Nov 22, 2020 • edited

oliviertassinari commented Nov 22, 2020 • edited

oliviertassinari Nov 28, 2020

Choose a reason for hiding this comment

oliviertassinari Nov 28, 2020

Choose a reason for hiding this comment

oliviertassinari Nov 28, 2020 • edited

Choose a reason for hiding this comment

oliviertassinari Nov 28, 2020

Choose a reason for hiding this comment

eps1lon commented Nov 29, 2020

oliviertassinari commented Nov 29, 2020 • edited

eps1lon commented Nov 30, 2020

oliviertassinari commented Nov 30, 2020 • edited

eps1lon commented Dec 3, 2020

oliviertassinari commented Dec 4, 2020 • edited

oliviertassinari commented Dec 4, 2020 • edited

oliviertassinari commented Nov 21, 2020 •

edited

mui-pr-bot commented Nov 21, 2020 •

edited

oliviertassinari commented Nov 22, 2020 •

edited

eps1lon commented Nov 22, 2020 •

edited

oliviertassinari commented Nov 22, 2020 •

edited

oliviertassinari Nov 28, 2020 •

edited

oliviertassinari commented Nov 29, 2020 •

edited

oliviertassinari commented Nov 30, 2020 •

edited

oliviertassinari commented Dec 4, 2020 •

edited

oliviertassinari commented Dec 4, 2020 •

edited