Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename Folders #3182

Merged
merged 16 commits into from
Mar 10, 2025
Merged

Rename Folders #3182

merged 16 commits into from
Mar 10, 2025

Conversation

jameskerr
Copy link
Member

  • Rename Packages
  • Rename zui-player to just player
  • Rename packages
  • Fix the readme
  • Remove zed
  • Remove zui from workflow
  • Fix build workflow
  • Fix workflows

@jameskerr jameskerr requested a review from philrz March 7, 2025 22:53
@philrz
Copy link
Contributor

philrz commented Mar 9, 2025

I've noticed when I run yarn test locally it now often (but not always) fails like I show below. I see when it starts running it flashes the message "Executing 3/3 remaining tasks in parallel..." so I'm guessing what's happening is the different tests each try to start their own lake on that port and sometimes the timing lines up just right such that they clash. This failure doesn't seem to have happened in Actions yet but I expect it might, so is there a good way to eliminate this problem?

$ yarn test
 
    ✔  nx run superdb-types:test (6s)

    ✖  nx run superdb-node-client:test
        PASS  dist/binpath.test.js
        PASS  src/binpath.test.ts
       listen tcp 127.0.0.1:9867: bind: address already in use
       context canceled
        PASS  src/lake.test.ts
        PASS  dist/field.test.js
        PASS  src/field.test.ts
        PASS  src/zjson.test.ts
        PASS  dist/zjson.test.js
        PASS  dist/zq.test.js
        PASS  src/zq.test.ts
        FAIL  dist/lake.test.js (6.745 s)
         ● serve the lake
       
           thrown: "Exceeded timeout of 5000 ms for a test.
           Add a timeout value to this test to increase the timeout, if this is a long-running test. See https://jestjs.io/docs/api#testname-fn-timeout."
       
              7 |     jest.setTimeout(30000);
              8 | }
           >  9 | test('serve the lake', async () => {
                | ^
             10 |     const root = join(os.tmpdir(), 'zed_node_lake_test');
             11 |     const lake = new Lake({ root, logs: root, addr: 'localhost' });
             12 |     lake.fetch = nodeFetch;
       
             at Object.test (dist/lake.test.js:9:1)
       
       Test Suites: 1 failed, 9 passed, 10 total
       Tests:       1 failed, 47 passed, 48 total
       Snapshots:   6 passed, 6 total
       Time:        7.285 s
       Ran all test suites.
       
       
    ✔  nx run superdb-desktop:test (17s)

 ———————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————

 >  NX   Ran target test for 3 projects (17s)
 
    ✔    2/3 succeeded [0 read from cache]
 
    ✖    1/3 targets failed, including the following:
         - nx run superdb-node-client:test

- [**zui-player**](packages/zui-player): the end-to-end testing framework for Zui
- [**superdb-types**](packages/superdb-types): the JavaScript library for the data types return from a server.
- [**superdb-node-client**](packages/superdb-node-client): the JavaScript library for [Node.js](https://nodejs.org/)
- [**player**](packages/app-player): the end-to-end testing framework for the desktop app
Copy link
Contributor

Choose a reason for hiding this comment

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

While the top-line PR description mentioned "Rename zui-player to just player", I noticed that the directory name in this branch is currently app-player. That was causing a link failure here in the README where it was pointing to just player. Since tests all seem to be passing with the directory being app-player I assume that's intentional so I made the change here in the link to satisfy the markdown link checker in CI.

Copy link
Contributor

@philrz philrz left a comment

Choose a reason for hiding this comment

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

I pushed a couple commits to fix hyperlinks that were failing in the markdown link checker in CI. One failure that remains is the one in apps/superdb-desktop/docs/developer/README.md to https://github.com/brimdata/zui/blob/main/apps/superdb-desktop/CONTRIBUTING.md but that'll start working once this PR merges so I'm happy to merge in this state.

Speaking of docs, I also just took the liberty of disabling the "Deploy to Netlify" Actions Workflow in the https://github.com/brimdata/zui-docs-site repo. Much like we did with https://zed.brimdata.io/, I expect we'll want to freeze https://zui.brimdata.io/ in its current state to benefit the legacy users that are still relying on the GA releases for now. At some point soon we can get started on adding automation to start publishing the SuperDB Desktop docs in a section of https://superdb.org/docs, so that can be the home for new app docs.

Regarding my comment above about the yarn test failures I've observed, I'm fine with merging this one and taking that up as a separate topic. This branch already touches so many files that it's difficult to work with in the GitHub UI.

@jameskerr
Copy link
Member Author

It looks like those tests are running on the "build" files in the dist folder. They aren't supposed to be doing that. Let me see how to ignore those...

@jameskerr jameskerr merged commit e76869e into main Mar 10, 2025
4 of 5 checks passed
@jameskerr jameskerr deleted the dezed branch March 10, 2025 22:36
Sign up for free to 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.

2 participants