Workbook package #3019
Workbook package #3019
Conversation
|
1. Your contributing guidelines mention I should skip writing tests for endpoints that don't support app auth. According to the docs, that's all of the workbook endpoints. Is there any way I can write tests we can use for these endpoints? Not really. You can test them locally. We are working on test recording to allow us to record delegated-auth tests and replay them to validate. 2. In my testing, I wasn't able to use workbook operations on items opened by path. These failed with "Could not obtain a WAC token". When I use getItemById, it works. I wrote this off as a Graph API bug, but haven't tested extensively. Don't know, WAC is the office protocol, perhaps that endpoint requires something special. 3. My current implementation of workbook sessions involves a I am not deeply familiar with this API, what is the difference between sessionless and with session? Do we need to expose both? 4. I've added a prefer-async behavior to the graph folder. This is to handle the long-running operation pattern that a few of the workbook endpoints support. Again, I'm not sure if this is the ideal approach, but it's what I've got at the moment. This is pretty slick, I left a few notes inline. This isn't something we built-in for v4 launch, but I can see a ton of value to including it. Again, nice work! |
A few of the collections from the workbook endpoints support getItemAt(index). I've implemented this in the same pattern as the getById decorator. Currently I've only added it to the rows collection.
- Replaced manual setTimeout with delay() - Directly invoked statusQuery rather than calling graphGet - Wrapped handler with standard library error checking via parseBinderWithErrorCheck
Oops! I didn't read parseBinderWithErrorCheck properly and missed that it runs the impl function on all HTTP successes. I only want prefer-async to trigger on 202 Accepted. Updated my behaviour to manually add an errorCheck parse handler before my own.
|
HI @ChapC is this ready? We see your changes, we were just waiting on anymore feedback from you. |
Endpoints for getting the Range contained by tables, rows, columns and worksheets. Plus added the 'clearFilter' endpoint to Table.
|
Hey @bcameron1231, I've just added a few more of the endpoints I've tested recently. I was hoping to cover much more of the workbook functionality, but I've ended up with much less time than I thought I would have on this. Apologies! So far, of all the workbook sections, I've implemented the basic stuff in Tables, Worksheets, Rows/Columns and Ranges. Everything to get/update/delete data in the spreadsheet. I have mocha tests for most of these on my local machine, although they're in a separate project as I had trouble getting it working with this one. There were a couple quirks I encountered in these endpoints. Most I mentioned previously, but the biggest one I couldn't find a fix for was incompatibility with paging. The async iterator doesn't work for table rows, because as far as I can tell the Graph API simply doesn't return There's still quite a bit more for full coverage of all endpoints, like charts, running formulas and cell styling. I'm happy to keep chipping away at these features, just won't have a timeframe for you unfortunately. I can get some documentation written up soon if you guys decide you'd like to merge just the stuff I've got working rather than the full set. Just let me know :) |
|
Also, to answer the question from @patrick-rodgers regarding session vs sessionless; my understanding is that both work for pretty much every endpoint, but using a session leads to better performance. It's briefly explained in the docs here. To quote them directly:
It also allows you to create non-persistent sessions, in which you can edit the workbook and run calculations without your changes being saved to the file. In sessionless mode, your changes are always immediately saved to the file. |
|
Sounds good @ChapC! No worries, we're all busy so appreciate any time you have to contribute 😀 Let us know once you're ready for a full review. Thank you!! |
Added endpoints for Range formatting. That includes borders, fill, font, row/column sizing, text alignment and protection.
Added a few more endpoints (sorting, various range getters) to fully cover table manipulation.
Added the Icon class, but I think the Graph API documentation is wrong. It's basically useless. See comments for details.
Didn't realise I need to type those. Whoops!
|
After a few more bursts of work, I've finished the majority of endpoints and now have something I think could be worth merging! The last group of endpoints still missing are the Chart-related ones (chart creation, data selection, styling). For now, I think I'll leave those ones as a neat package for another PR down the road (either from myself or someone else who's keen). The other thing I still need to write is documentation. As you can see from the MS docs, there are quite a few sections to cover. I'm planning on having most of them just point straight to the docs and adding a few examples for common tasks/quirks. There are also a few places where the official docs appear to be incorrect. I've noted these as comments in the code where applicable. The biggest of those quirks are the ones I mentioned earlier in this thread: async paging doesn't seem to work and you must open a workbook on an DriveItem ID rather than path. If it's something that's out of our hands, I'll just leave a note in the documentation. Let me know what you think! |
|
@ChapC - this is awesome! On the docs - you don't need to go too crazy - really just pointers on how to use THIS library. No need to document the full feature, that's the product's job. You can check out our other docs for how we've approached it - very minimal just to get folks started. One small nit we found doing another review is the Once you have the docs this looks really solid, excited to get it merged!! Thank you for taking the time to contribute 🙂 |
Category
Related Issues
Mentioned in #3016
What's in this Pull Request?
Initial draft of Excel workbook support.
This first commit includes
I'll implement more endpoints as I go, but have a couple of notes/questions I thought I'd post here first.
workbookproperty on DriveItem that leads to a regular, sessionless IWorkbook and an async methodgetWorkbookSessionthat resolves to an IWorkbookWithSession. The latter is an extension of IWorkbook that adds session refresh/close methods, and uses the InjectHeaders behaviour to add the session id header. Thoughts on this approach?Welcoming all feedback. Thanks!