Convert to v2 addon #576

SergeAstapov · 2022-05-03T02:38:52Z

SergeAstapov · 2022-05-03T02:51:13Z

.github/workflows/ci.yml

 with:
 node-version: 12.x
 cache: npm
+
+ - name: npm8
+ run: npm install -g npm@8


npm@8 is needed for workspaces support

SergeAstapov · 2022-05-03T02:52:03Z

LICENSE

@@ -1,19 +0,0 @@
-Copyright (c) 2015-2016 Santiago Ferreira


deleted in favor of LICENSE.md

SergeAstapov · 2022-05-03T02:52:50Z

README.md

 * Ember.js v3.16 or above
 * Ember CLI v2.13 or above
-* Node.js v10 or above
+* Node.js v12 or above


engines field already requires v12, hence it's not technically dropping support for Node.js v10 but a correction in readme

SergeAstapov · 2022-05-03T02:53:30Z

addon/.eslintrc.js

+
+module.exports = {
+ root: true,
+ parser: '@babel/eslint-parser',


this is for ESLint v8 support

SergeAstapov · 2022-05-03T02:55:20Z

addon/node-tests/blueprints/page-object-component-test.js

-var setupTestHooks = blueprintHelpers.setupTestHooks;
-var emberNew = blueprintHelpers.emberNew;
-var emberGenerateDestroy = blueprintHelpers.emberGenerateDestroy;
+let blueprintHelpers = require('ember-cli-blueprint-test-helpers/helpers');


changes in this files made to make prettier happy

SergeAstapov · 2022-05-03T02:56:20Z

addon/src/-private/finders.js

@@ -1,5 +1,5 @@
 import { $, buildSelector, findClosestValue, guardMultiple } from './helpers';
-import { getAdapter } from '../adapters';
+import { getAdapter } from '../adapters/index';


rollup wasn't happy with previous path :/

SergeAstapov · 2022-05-03T02:56:56Z

addon/src/-private/helpers.js

+
+let jQuery;
+
+if (macroCondition(dependencySatisfies('@ember/jquery', '*'))) {


this is to use jquery shipped by @ember/jquery if present, otherwise includes own jquery

SergeAstapov · 2022-05-03T02:58:02Z

addon/src/-private/run.js

@@ -1,5 +1,4 @@
-import { resolve } from 'rsvp';
-import { getAdapter } from '../adapters';
+import { getAdapter } from '../adapters/index';


this changed to make rollup happy and rsvp removed as ember-source package ships rsvp bundled in hence we can't ship own copy.
Luckily, we could easily switch to native promise

SergeAstapov · 2022-05-03T03:00:16Z

docs/package.json

+ "private": true,
+ "description": "Docs app for ember-cli-page-object",
+ "scripts": {
+ "build": "node ./index.js"


now docs/guides completely separated from the addon and the test addon

SergeAstapov · 2022-05-03T03:00:39Z

test-app/.eslintrc.js

@@ -2,12 +2,17 @@

 module.exports = {
 root: true,
+ parser: '@babel/eslint-parser',


this allows using ESLint v8

ro0gr · 2022-05-16T21:55:02Z

Thank you very much for this work! I'll do my best to check it this weekend.

ro0gr · 2022-06-13T21:42:33Z

Overall looks fantastic!

Me, as a not an active monorepo user, is mostly interested in how to release the thing? At the moment we have the following release instructions https:/san650/ember-cli-page-object/wiki/How-to-release-a-new-version.

May you provide steps to release the /addon with /docs, so I can figure out how to update documentation, please?

NullVoxPopuli · 2022-07-06T22:19:04Z

any chance we can get this released -- I'm trying to upgrade to ember 4 / deal with ember 3.28 deprecations and ember-cli-page-object is my last blocker

@ro0gr , re: releasing

the addon folder with "just" be npm publish (after cding into /addon)

for docs, looks like you use this: https:/san650/ember-cli-page-object/blob/master/docs.js

we'd need to test it out, but I think you'd move that file into the docs folder and just invoke it.
oh! this needs updating: https:/san650/ember-cli-page-object/blob/master/docs.js#L264

NullVoxPopuli · 2022-07-06T22:35:53Z

@SergeAstapov is this a non-breaking change? (other than now requiring ember-auto-import@v2?)

SergeAstapov · 2022-07-07T02:22:05Z

@ro0gr I'm sorry, missed you question.

TL;DR I will create a PR adding release-it config and adding RELEASE.md with release instructions (which would be very simple).

Longer answer.
I would go with release-it for release automation: it is pretty simple to setup (e.g. you can see PR in ember-click-outside-modifier as an example) and we can setup docs deploy via the hook (like it's done in ember-keyboard).

As a pros, it automatically publishes to npm, creates GitHub release, generates changelog and monorepo setup is super simple (thanks to release-it-yarn-workspaces plugin)

The only downside (in my opinion) - it requires labels to be added to pull requests.

semantic-release or standard-version could be another option, however to me they are not that straightforward and easy to use as release-it and they require diligence in commit messages (which hard to change retrospectively compared to PR labels)

@NullVoxPopuli correct, no breaking changes except ember-auto-import@v2 (which *is* a breaking change).

docs: fix api docs generation

docs/index.js

ro0gr · 2022-07-07T22:27:13Z

@SergeAstapov thank you for the update!

I do really like an idea of release automation. However, I don't want to block this PR with it, since it's already a great move! I think for the time being we can live with a manual release process, while we have it clearly defined. And we can deliver release automation separately.

My question for now is how do we intend to release the whole thing? To me it looks like it's fine just release the /addon dir. If such, I believe we should update the docs generator script(#576 (comment)).

What do you think about the preferred release strategy, if leave an exact release tool out of the equation for now?

SergeAstapov · 2022-07-08T02:24:21Z

@ro0gr sure, totally makes sense to keep release process as is and I'll submit follow up PR where we can work on automation separately.

We just should make following changes in https:/san650/ember-cli-page-object/wiki/How-to-release-a-new-version:

make sure both npm version and npm publish run from addon folder.
replace npm run docs command with cd ../docs && npm run build

Rest of the steps don't seem to change.

ro0gr · 2022-07-19T22:09:47Z

Hey @SergeAstapov, thanks for the update!

I'm trying to figure out CI failure for the test scenarios w/o a lock file:

not ok 1 Chrome 103.0 - [undefined ms] - Global error: Uncaught Error: Could not find module @glimmer/manager imported from (require) at http://localhost:7357/assets/vendor.js, line 259

I think this is first time I see this kind of error. The current v2-beta branch does not have this failure(see #578). Do you have an idea which change can cause this?

ro0gr · 2022-07-19T22:44:41Z

Alright, seems like downgrading to the "@ember/test-helpers": "~2.7.0" does the trick. For some reason we end up in the https:/emberjs/ember-test-helpers/blob/2b1ddcc91a971e1a3e1509d55f711778c32984b1/addon-test-support/%40ember/test-helpers/-internal/get-component-manager.ts#L14-L17, which does not make sense to me and might mean some underlying bug there. I'll need some time to wrap my head around this issue.

Meanwhile feel free to add a commit to downgrade the test helpers if you want for now. Anyways, I'll do my best to finally cut the release this week.

ro0gr · 2022-07-21T22:40:07Z

test-app/package.json

+ "ember-cli-doc-server": "1.1.0",
+ "ember-cli-htmlbars": "^6.0.1",
+ "ember-cli-inject-live-reload": "^1.8.2",
+ "ember-cli-page-object": "2.0.0-beta.3",


I've just noticed this, and I wonder if this is supposed to be a relative path, or use * instead of the hardcoded version?

ro0gr · 2022-07-30T21:55:51Z

Well, I figured out test failures and fixed it by migrating to pnpm #579

ro0gr · 2022-07-30T21:56:30Z

@SergeAstapov thank you! 🚀

NullVoxPopuli · 2022-07-30T22:02:00Z

fixed it by migrating to pnpm

Yet another situation where pnpm saves the day!

ro0gr · 2022-07-31T14:35:58Z

just published it as 2.0.0-beta.4

Convert to monorepo

e0bb3c3

SergeAstapov mentioned this pull request May 3, 2022

migrate to v2 Addon Format #575

Closed

SergeAstapov commented May 3, 2022

View reviewed changes

Convert to v2 addon

1a1c910

SergeAstapov force-pushed the v2-addon branch from 65566d8 to 1a1c910 Compare May 3, 2022 03:03

ro0gr added 2 commits June 12, 2022 14:50

docs: fix addon name

3ccd74b

fix api docs generation

e2fcb05

ro0gr mentioned this pull request Jun 13, 2022

gitignore v2 addon directories #577

Merged

Merge pull request #2 from ro0gr/docs/v2-addon-fixups

cc29865

docs: fix api docs generation

ro0gr reviewed Jul 7, 2022

View reviewed changes

docs/index.js Outdated Show resolved Hide resolved

Pull addon version from addon/package.json file

440f438

ro0gr reviewed Jul 21, 2022

View reviewed changes

ro0gr mentioned this pull request Jul 22, 2022

migrate to pnpm #579

Merged

ro0gr merged commit 05390f2 into san650:v2-beta Jul 30, 2022

ginomiglio mentioned this pull request Aug 18, 2022

Build error when using ember-cli-page-object v2.0.0-beta.4 Addepar/ember-classy-page-object#39

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Convert to v2 addon #576

Convert to v2 addon #576

SergeAstapov commented May 3, 2022

SergeAstapov May 3, 2022

SergeAstapov May 3, 2022

SergeAstapov May 3, 2022

SergeAstapov May 3, 2022

SergeAstapov May 3, 2022

SergeAstapov May 3, 2022

SergeAstapov May 3, 2022

SergeAstapov May 3, 2022

SergeAstapov May 3, 2022

SergeAstapov May 3, 2022

ro0gr commented May 16, 2022

ro0gr commented Jun 13, 2022 •

edited

Loading

NullVoxPopuli commented Jul 6, 2022

NullVoxPopuli commented Jul 6, 2022

SergeAstapov commented Jul 7, 2022

ro0gr commented Jul 7, 2022

SergeAstapov commented Jul 8, 2022

ro0gr commented Jul 19, 2022

ro0gr commented Jul 19, 2022

ro0gr Jul 21, 2022

ro0gr commented Jul 30, 2022

ro0gr commented Jul 30, 2022

NullVoxPopuli commented Jul 30, 2022

ro0gr commented Jul 31, 2022


		let jQuery;

		if (macroCondition(dependencySatisfies('@ember/jquery', '*'))) {

Convert to v2 addon #576

Convert to v2 addon #576

Conversation

SergeAstapov commented May 3, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ro0gr commented May 16, 2022

ro0gr commented Jun 13, 2022 • edited Loading

NullVoxPopuli commented Jul 6, 2022

NullVoxPopuli commented Jul 6, 2022

SergeAstapov commented Jul 7, 2022

ro0gr commented Jul 7, 2022

SergeAstapov commented Jul 8, 2022

ro0gr commented Jul 19, 2022

ro0gr commented Jul 19, 2022

Choose a reason for hiding this comment

ro0gr commented Jul 30, 2022

ro0gr commented Jul 30, 2022

NullVoxPopuli commented Jul 30, 2022

ro0gr commented Jul 31, 2022

ro0gr commented Jun 13, 2022 •

edited

Loading